Merge pull request #50 from jeremiaheb/autosave-prototype

Autosave/draft prototype

Author: alindeman

app/assets/javascripts/application.js

@@ -21,9 +21,16 @@
 //= require bootstrap
 //= require jquery-ui/datepicker
 //= require jquery_nested_form
+//= require underscore-umd
 //= require_tree ../../../vendor/assets/javascripts
-//= require_tree .
 //
+//= require ./benthic_covers
+//= require ./boat_logs
+//= require ./coral_demographics
+//= require ./samples
+//= require ./static_pages
+//= require ./drafts
+//= require_self
 
 // Set up our EA namespace for our functions
 var EA = {};

app/assets/javascripts/drafts.js

@@ -0,0 +1,74 @@
+$(function() {
+  // The main function that serializes the form and sends it to the save draft endpoint.
+  //
+  // It is wrapped in _.throttle so it is called on the trailing edge at most
+  // once in a 3 second window. More casually this means no matter how many
+  // times the function is called within a 3 second window, the code will only
+  // actually be executed once at the end of the window.
+  //
+  // The draft is therefore saved periodically and after things have "settled,"
+  // but not so often as to flood the server with requests.
+  var currentDraftRequest;
+  const saveDraftThrottled = _.throttle(function(e) {
+    let $target = $(e.target);
+    let $form = $target.closest("form");
+    let draftsURL = $form.data("drafts-url");
+
+    if (!draftsURL) {
+      return;
+    }
+
+    if (currentDraftRequest) {
+      currentDraftRequest.abort();
+      currentDraftRequest = null;
+    }
+
+    let params = $form.serializeArray();
+    params.push({ name: "sequence", value: (new Date()).getTime() });
+    params.push({ name: "focused_dom_id", value: $(document.activeElement).attr("id") });
+
+    currentDraftRequest = $.ajax({
+      type: "PUT",
+      url: draftsURL,
+      data: $.param(params),
+      headers: {
+        "X-CSRF-Token": $("meta[name='csrf-token']").attr("content"),
+      },
+      withCredentials: true,
+      success: function(data, textStatus, jqXHR) {
+        $form.trigger("draft:success", [data, textStatus, jqXHR]);
+      },
+      error: function(jqXHR, textStatus, errorThrown) {
+        if (textStatus === "abort") {
+          return;
+        }
+
+        $form.trigger("draft:error", [jqXHR, textStatus, errorThrown]);
+
+        // Retry. Rely on throttle to coalesce multiple calls into one retry.
+        saveDraftThrottled(e);
+      },
+    });
+  }, 3000, { leading: false });
+
+  // Save drafts for forms where data-drafts-url is present as an attribute.
+  const $formsWithDraftsURLs = $("form[data-drafts-url]");
+  $formsWithDraftsURLs.on("blur change", ":input", saveDraftThrottled)
+
+  // Trigger validation and cursor restoration for draft-enabled forms
+  $formsWithDraftsURLs.each(function() {
+    const $form = $(this);
+    if ($form.data("draft-restored")) {
+      $form.validate().form(); // trigger validation
+    }
+    if ($form.data("draft-focused-dom-id")) {
+      $("#" + $form.data("draft-focused-dom-id")).focus();
+    }
+  });
+
+  // After the draft is discarded, reload the page to empty out all fields and
+  // start from scratch cleanly.
+  $("a.discard-draft-link").on("ajax:complete", function(e) {
+    location.reload(true);
+  });
+});

app/controllers/benthic_covers_controller.rb

@@ -49,12 +49,17 @@ def show
   # GET /benthic_covers/new
   # GET /benthic_covers/new.json
   def new
-    @benthic_cover = BenthicCover.new
-
-    @benthic_cover.build_invert_belt
-    @benthic_cover.build_presence_belt
-    @benthic_cover.point_intercepts.build
-    @benthic_cover.build_rugosity_measure
+    @draft = Draft.latest_for(diver_id: current_diver.id, model_klass: BenthicCover, model_id: nil)
+    if @draft
+      @benthic_cover = BenthicCover.new(@draft.model_attributes)
+    else
+      @benthic_cover = BenthicCover.new.tap do |b|
+        b.build_invert_belt
+        b.build_presence_belt
+        b.point_intercepts.build
+        b.build_rugosity_measure
+      end
+    end
 
     respond_to do |format|
       format.html # new.html.erb
@@ -64,7 +69,12 @@ def new
 
   # GET /benthic_covers/1/edit
   def edit
-    @benthic_cover = BenthicCover.find(params[:id])
+    @draft = Draft.latest_for(diver_id: current_diver.id, model_klass: BenthicCover, model_id: params[:id])
+    if @draft
+      @benthic_cover = BenthicCover.new(@draft.model_attributes.merge(id: params[:id]))
+    else
+      @benthic_cover = BenthicCover.find(params[:id])
+    end
   end
 
   # POST /benthic_covers
@@ -74,6 +84,8 @@ def create
 
     respond_to do |format|
       if @benthic_cover.save
+        Draft.destroy_for(diver_id: current_diver.id, model_klass: BenthicCover, model_id: nil)
+
         format.html { redirect_to benthic_covers_path, notice: 'Benthic cover was successfully created.' }
         format.json { render json: @benthic_cover, status: :created, location: @benthic_cover }
       else
@@ -90,6 +102,8 @@ def update
 
     respond_to do |format|
       if @benthic_cover.update(benthic_cover_params)
+        Draft.destroy_for(diver_id: current_diver.id, model_klass: BenthicCover, model_id: @benthic_cover.id)
+
         format.html { redirect_to benthic_covers_path, notice: 'Benthic cover was successfully updated.' }
         format.json { head :no_content }
       else
@@ -111,6 +125,31 @@ def destroy
     end
   end
 
+  # PUT /draft
+  def draft
+    # Handle intentional delete of draft data
+    unless params[:benthic_cover].present?
+      Draft.destroy_for(diver_id: current_diver.id, model_klass: BenthicCover, model_id: params[:id])
+
+      head :ok
+      return
+    end
+
+    draft = Draft.new(
+      diver_id: current_diver.id,
+      model_klass: BenthicCover,
+      model_id: benthic_cover_params[:id],
+      model_attributes: benthic_cover_params,
+      sequence: params[:sequence],
+      focused_dom_id: params[:focused_dom_id],
+    )
+    if draft.save
+      render json: {}, status: :created
+    else
+      render json: draft.errors, status: :unprocessable_entity
+    end
+  end
+
   private
 
   def benthic_cover_params

app/controllers/coral_demographics_controller.rb

@@ -50,9 +50,14 @@ def show
   # GET /coral_demographics/new
   # GET /coral_demographics/new.json
   def new
-    @coral_demographic = CoralDemographic.new
-
-    @coral_demographic.demographic_corals.build
+    @draft = Draft.latest_for(diver_id: current_diver.id, model_klass: CoralDemographic, model_id: nil)
+    if @draft
+      @coral_demographic = CoralDemographic.new(@draft.model_attributes)
+    else
+      @coral_demographic = CoralDemographic.new.tap do |c|
+        c.demographic_corals.build
+      end
+    end
 
     respond_to do |format|
       format.html # new.html.erb
@@ -62,7 +67,12 @@ def new
 
   # GET /coral_demographics/1/edit
   def edit
-    @coral_demographic = CoralDemographic.find(params[:id])
+    @draft = Draft.latest_for(diver_id: current_diver.id, model_klass: CoralDemographic, model_id: params[:id])
+    if @draft
+      @coral_demographic = CoralDemographic.new(@draft.model_attributes.merge(id: params[:id]))
+    else
+      @coral_demographic = CoralDemographic.find(params[:id])
+    end
   end
 
   # POST /coral_demographics
@@ -72,6 +82,8 @@ def create
 
     respond_to do |format|
       if @coral_demographic.save
+        Draft.destroy_for(diver_id: current_diver.id, model_klass: CoralDemographic, model_id: nil)
+
         format.html { redirect_to coral_demographics_path, notice: 'Coral demographic was successfully created.' }
         format.json { render json: @coral_demographic, status: :created, location: @coral_demographic }
       else
@@ -88,6 +100,8 @@ def update
 
     respond_to do |format|
       if @coral_demographic.update(coral_demographic_params)
+        Draft.destroy_for(diver_id: current_diver.id, model_klass: CoralDemographic, model_id: @coral_demographic.id)
+
         format.html { redirect_to coral_demographics_path, notice: 'Coral demographic was successfully updated.' }
         format.json { head :no_content }
       else
@@ -109,6 +123,31 @@ def destroy
     end
   end
 
+  # PUT /draft
+  def draft
+    # Handle intentional delete of draft data
+    unless params[:coral_demographic].present?
+      Draft.destroy_for(diver_id: current_diver.id, model_klass: CoralDemographic, model_id: params[:id])
+
+      head :ok
+      return
+    end
+
+    draft = Draft.new(
+      diver_id: current_diver.id,
+      model_klass: CoralDemographic,
+      model_id: coral_demographic_params[:id],
+      model_attributes: coral_demographic_params,
+      sequence: params[:sequence],
+      focused_dom_id: params[:focused_dom_id],
+    )
+    if draft.save
+      render json: {}, status: :created
+    else
+      render json: draft.errors, status: :unprocessable_entity
+    end
+  end
+
   private
 
   def coral_demographic_params

app/controllers/samples_controller.rb

@@ -57,11 +57,14 @@ def show
   # GET /samples/new
   # GET /samples/new.json
   def new
-    @sample = Sample.new
-
-    2.times { @sample.diver_samples.build }
-    @sample.sample_animals.build
-
+    @draft = Draft.latest_for(diver_id: current_diver.id, model_klass: Sample, model_id: nil)
+    if @draft
+      @sample = Sample.new(@draft.model_attributes)
+    else
+      @sample = Sample.new.tap do |s|
+        s.sample_animals.build
+      end
+    end
 
     respond_to do |format|
       format.html # new.html.erb
@@ -71,8 +74,12 @@ def new
 
   # GET /samples/1/edit
   def edit
-    @sample = Sample.find(params[:id])
-
+    @draft = Draft.latest_for(diver_id: current_diver.id, model_klass: Sample, model_id: params[:id])
+    if @draft
+      @sample = Sample.new(@draft.model_attributes.merge(id: params[:id]))
+    else
+      @sample = Sample.find(params[:id])
+    end
   end
 
   # POST /samples
@@ -82,6 +89,8 @@ def create
 
     respond_to do |format|
       if @sample.save
+        Draft.destroy_for(diver_id: current_diver.id, model_klass: Sample, model_id: nil)
+
         format.html { redirect_to samples_path, notice: 'Sample was successfully created.' }
         format.json { render json: @sample, status: :created, location: @sample }
       else
@@ -98,6 +107,8 @@ def update
 
     respond_to do |format|
       if @sample.update(sample_params)
+        Draft.destroy_for(diver_id: current_diver.id, model_klass: Sample, model_id: @sample.id)
+
         format.html { redirect_to samples_path, notice: 'Sample was successfully updated.' }
         format.json { head :no_content }
       else
@@ -119,6 +130,31 @@ def destroy
     end
   end
 
+  # PUT /draft
+  def draft
+    # Handle intentional delete of draft data
+    unless params[:sample].present?
+      Draft.destroy_for(diver_id: current_diver.id, model_klass: Sample, model_id: params[:id])
+
+      head :ok
+      return
+    end
+
+    draft = Draft.new(
+      diver_id: current_diver.id,
+      model_klass: Sample,
+      model_id: sample_params[:id],
+      model_attributes: sample_params,
+      sequence: params[:sequence],
+      focused_dom_id: params[:focused_dom_id],
+    )
+    if draft.save
+      render json: {}, status: :created
+    else
+      render json: draft.errors, status: :unprocessable_entity
+    end
+  end
+
   def proofing_template
     @sample = Sample.find(params[:id])
 

app/helpers/samples_helper.rb

@@ -1,2 +1,8 @@
 module SamplesHelper
+  def diver_samples_primary_first(diver_samples)
+    [
+      diver_samples.find { |ds| ds.primary_diver? } || diver_samples.build(primary_diver: true, diver_id: current_diver.id),
+      diver_samples.find { |ds| !ds.primary_diver? } || diver_samples.build(primary_diver: false),
+    ].compact
+  end
 end

app/models/ability.rb

@@ -35,6 +35,7 @@ def initialize(current_diver)
     elsif current_diver.role == 'manager'
       can :manage, [Sample, BenthicCover, CoralDemographic, BoatLog]
     elsif current_diver.role == 'diver'
+      can :draft, [Sample, BenthicCover, CoralDemographic]
       can :create, [Sample, BenthicCover, CoralDemographic]
       can :read, [Sample, BenthicCover, CoralDemographic]
       can :destroy, [Sample, BenthicCover, CoralDemographic]
@@ -48,6 +49,5 @@ def initialize(current_diver)
         coral_demographic.try(:myId) == current_diver.id
       end
     end
-
   end
 end

app/models/diver_sample.rb

@@ -5,5 +5,6 @@ class DiverSample < ActiveRecord::Base
   scope :primary, lambda { where(primary_diver: true) }
   scope :secondary, lambda { where(primary_diver: false) }
 
+  validates :primary_diver, inclusion: [true, false]
   validates :diver_id, :presence => true
 end