Class: Jobs::Analysis::PlotDates

Inherits:
Base show all
Defined in:
lib/jobs/analysis/plot_dates.rb

Overview

Plot a dataset's members by year

Instance Attribute Summary

Attributes inherited from Base

#dataset_id, #user_id

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Base

#error, job_list, view_path

Methods inherited from Base

#==, #attributes, #error, #initialize, #max_attempts

Constructor Details

This class inherits a constructor from Jobs::Base

Class Method Details

+ (Boolean) download?

We don't want users to download the YAML file

Returns:

  • (Boolean) 


80
 
# File 'lib/jobs/analysis/plot_dates.rb', line 80

def self.download?; false; end

Instance Method Details

- (undefined) perform

Export the date format data

Like all view/multiexport jobs, this job saves its data out as a YAML file and then sends it to the user in various formats depending on user selectons

Examples:

Start a job for plotting a dataset by year

Delayed::Job.enqueue Jobs::Analysis::PlotDates.new(
  :user_id => current_user.to_param, 
  :dataset_id => dataset.to_param)

Returns:

  • (undefined)

Raises:

  • (ArgumentError) 


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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/jobs/analysis/plot_dates.rb', line 20

def perform        
  # Fetch the user based on ID
  user = User.find(user_id)
  raise ArgumentError, 'User ID is not valid' unless user

  # Fetch the dataset based on ID
  dataset = user.datasets.find(dataset_id)
  raise ArgumentError, 'Dataset ID is not valid' unless dataset
  
  # Make a new analysis task
  @task = dataset.analysis_tasks.create(:name => "Plot dataset by date", :job_type => 'PlotDates')
  
  # Write out the dates to an array
  dates = []
  dataset.entries.find_in_batches do |group|
    # Build a Solr query to fetch only the year for this group
    solr_query = {}
    solr_query[:rows] = group.count
    query_str = group.map { |e| e.shasum }.join(' OR ')
    solr_query[:q] = "shasum:(#{query_str})"
    solr_query[:qt] = 'precise'
    solr_query[:fl] = 'year'
    solr_query[:facet] = false

    solr_response = Solr::Connection.find solr_query
    raise StandardError, "Unknown error in Solr response" unless solr_response.ok?
    raise StandardError, "Failed to get batch of results in PlotDates" unless solr_response["response"]["docs"].count == group.count

    solr_response['response']['docs'].each do |doc|
      year = doc["year"]
      year.force_encoding(Encoding::UTF_8)

      # Support Y-M-D or Y/M/D dates
      parts = year.split(/[-\/]/)
      year = Integer(parts[0])

      year_array = dates.assoc(year)
      if year_array
        year_array[1] = year_array[1] + 1
      else
        dates << [ year, 1 ]
      end
    end
  end
  
  # Sort by date
  dates = dates.sort_by { |y| y[0] }
  
  # Serialize out to YAML
  @task.result_file = Download.create_file('dates.yml') do |file|
    file.write(dates.to_yaml)
    file.close
  end
  
  # Make sure the task is saved, setting 'finished_at'
  @task.finished_at = DateTime.current
  @task.save
end