Class: Codebook

Inherits:
Object
  • Object
show all
Includes:
ExtractEngine::FileManagement
Defined in:
app/models/codebook.rb

Overview

Provisional codebook generator This might better live in /lib/extract_engine or /app/classes.

Instance Method Summary collapse

Constructor Details

#initialize(request) ⇒ Codebook

Returns a new instance of Codebook.



6
7
8
 
# File 'app/models/codebook.rb', line 6

def initialize(request)
  @request = request
end

Instance Method Details

#build ⇒ Object 



69
70
71
72
73
74
75
76
77
78
 
# File 'app/models/codebook.rb', line 69

def build
  b = binding
  # create and run templates, filling member data variables
  ERB.new("      <%= PRODUCT[:name] %>
    <%= PRODUCT[:desc] %>
".gsub(/^\s+/, ""), 0, "", "@product").result b
  ERB.new("      <%= PRODUCT[:name] %> -- <%= PRODUCT[:cost] %>
    <%= PRODUCT[:desc] %>
".gsub(/^\s+/, ""), 0, "", "@price").result b
end

#codebook_filename ⇒ Object 



80
81
82
 
# File 'app/models/codebook.rb', line 80

def codebook_filename
  File.join(request.location, request.name + ".txt")
end

#extra_files ⇒ Object 



11
12
13
 
# File 'app/models/codebook.rb', line 11

def extra_files
  @extra_files || []
end

#generate ⇒ Object 



88
89
90
 
# File 'app/models/codebook.rb', line 88

def generate
  @request.extract_type == ExtractRequest::ExtractTypeConst::RASTER ? generate_raster_codebook : generate_micro_or_area_data_codebook
end

#generate_codebook ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'app/models/codebook.rb', line 56

def generate_codebook
  @extra_files = []
  create_directories(request)
  
  str = File.open(File.join(Rails.root, 'app/views/codebooks/arealevel_with_raster.txt.erb'), 'r:UTF-8'){|f| f.read}
  b = binding
  
  File.open(new_codebook_filename, 'w:UTF-8') do |f|
    f.write(ERB.new(str).result(b))
  end
  
end

#generate_file ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'app/models/codebook.rb', line 16

def generate_file
  @extra_files = []
  create_directories(request)
  codebook_text = generate
  Rails.logger.debug codebook_text

  begin
    File.open(codebook_filename, 'w:UTF-8') {|f| f.puts(codebook_text.force_encoding("UTF-8"))}
  rescue Exception => e
    Rails.logger.debug e.backtrace

    begin
      File.open(codebook_filename, 'w') {|f| f.puts(codebook_text)}
    rescue Exception => ee
      Rails.logger.debug ee.backtrace
    end
  end

  Rails.logger.debug "Codebook for "  + @request.extract_type.to_s

  if request.samples.count > 0
    # Microdata Citation(s) needed
  end

  if request.terrapop_samples.count > 0
    # Area-data Citation(s) needed
  end

  if request.raster_datasets.count > 0
    # raster citation(s) needed
  end

  if @request.extract_type == ExtractRequest::ExtractTypeConst::RASTER
    Rails.logger.debug "Write raster codebook #{@request.name}"
    xml_metadata_file = @request.location # File.join(@request.location,@request.name)
    write_original_raster_metadata(xml_metadata_file)
  end

end

#generate_micro_or_area_data_codebook ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'app/models/codebook.rb', line 136

def generate_micro_or_area_data_codebook
  output = ["Code book generated on #{Time.now.to_s}."]
  output += [heading]
  output << ""
  output << "Datasets: "
  output << "Name\tDescription\tDensity"
  output << samples_used
  output << ""

  if request.has_area_data_variables?
    output << "Area-level Variables"
    output << "Mnemonic\tLabel\tMeasurement Type"
    output << area_variables
  end

  if request.has_raster_variables?
    output << ""
    output << "Raster Variables"
    output << "Mnemonic\tLabel\tOperation\tUnits"
    output << raster_variables
  end

  if request.has_microdata_variables?
    output << ""
    output << "Microdata Variables"
    output << "Mnemonic\tLabel\tRecord Type\tImplied Decimals"
    output << microdata_variables
    output <<  ""
    output << variable_categories
  end

  lines = ""

  begin
    lines = output.flatten.map { |ele|
      ele.force_encoding("UTF-8")
    }.join("\n")
  rescue Exception => e
    Rails.logger.debug "======================================================\n\n\n"
    output.flatten.each{|line| Rails.logger.debug line.encoding.to_s + " == '" + line + "'"}
    raise e
  end

  lines
end

#generate_raster_codebook ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'app/models/codebook.rb', line 93

def generate_raster_codebook
  output = ["Code book generated on #{Time.now.to_s}."]
  output += ["filename\tmnemonic\tvariable name\tsource dataset"]

  @request.expanded_request_raster_variables.each do |v|
    v.raster_variable.raster_datasets.each{|rd|
      output << "#{v.raster_variable.filename}\t#{v.mnemonic}\t#{v.raster_variable.long_mnemonic}\t#{rd.source}"
    }
  end

  output << ""

  @request.expanded_request_raster_variables.each do |v|
    unless  v.raster_variable.raster_categories.empty?
      output << "#{v.mnemonic} codes and labels"
      output << ""
      begin
        v.raster_variable.raster_categories.each do |category|
          output << "#{category.code}\t#{category.label}"
        end
      rescue
        $stderr.puts "RasterVariable does not have contain RasterCategories"
      end
        
    end
  end

  output.join("\n")
end

#new_codebook_filename ⇒ Object 



84
85
86
 
# File 'app/models/codebook.rb', line 84

def new_codebook_filename
  File.join(request.location, request.name + "_.txt")
end

#write_original_raster_metadata(codebook_name_location) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
 
# File 'app/models/codebook.rb', line 124

def write_original_raster_metadata(codebook_name_location)
  @request.expanded_request_raster_variables.each {|v|
    variable_metadata_file = File.join(codebook_name_location, v.mnemonic + ".tiff.xml")
    f = File.open(variable_metadata_file,"w:UTF-8")
    metadata = v.raster_variable.raster_metadata
    metadata ? f.write(v.raster_variable.raster_metadata.original_metadata) : f.write("No metadata available")
    f.close
    @extra_files << variable_metadata_file
  }
end