updated preferences to use JSON hash and be contained in a new model, addresses #481

Author: xsrust

app/controllers/registrations_controller.rb

@@ -2,7 +2,8 @@
 class RegistrationsController < Devise::RegistrationsController
 
   def edit
-    @user.create_default_preferences if @user.prefs == {}
+    @user = current_user
+    @prefs = @user.get_preferences(:email)
     @languages = Language.sorted_by_abbreviation
     @orgs = Org.where(parent_id: nil).order("name")
     @other_organisations = Org.where(parent_id: nil, is_other: true).pluck(:id)

app/controllers/users_controller.rb

@@ -58,28 +58,36 @@ def admin_update_permissions
     end
   end
 
-  def update_preferences
-    @user = User.find(params[:user_id])
+  def update_email_preferences
     prefs = params[:prefs]
-    authorize @user, :update?
-    # Set all preferences to false
-    @user.prefs.each do |key, value|
-      value.each_key do |k|
-        @user.prefs[key][k] = false
-      end
+    authorize current_user, :update?
+    pref = current_user.pref
+    # does user not have prefs?
+    if pref.blank?
+      pref = Pref.new
+      pref.settings = {}
+      pref.user = current_user
     end
+    pref.settings[:email] = booleanize_hash(prefs)
+    pref.save
 
-    # Sets the preferences the user wants to true
-    if prefs
-      prefs.each_key do |key|
-        prefs[key].each_key do |k|
-          @user.prefs[key.to_sym][k.to_sym] = true
-        end
-      end
-    end
     @tab = params[:tab]
-    @user.save
     redirect_to edit_user_registration_path(tab: @tab), notice: success_message(_('preferences'), _('saved'))
   end
 
+  private
+
+  ##
+  # html forms return our boolean values as strings, this converts them to true/false
+  def booleanize_hash(node)
+    #leaf: convert to boolean and return
+    #hash: iterate over leaves
+    unless node.is_a?(Hash)
+      return node == "true"
+    end
+    node.each do |key, value|
+      node[key] = booleanize_hash(value)
+    end
+  end
+
 end

app/models/pref.rb

@@ -0,0 +1,19 @@
+class Pref < ActiveRecord::Base
+  ##
+  # Serialize prefs to JSON
+  # The settings object only stores deviations from the default
+  serialize :settings, JSON
+
+  ##
+  # Associations
+  belongs_to :user
+
+  ##
+  # Returns the hash generated from default preferences
+  #
+  # @return [JSON] preferences hash
+  def self.default_settings
+    return Rails.configuration.branding[:preferences]
+  end
+
+end

app/models/user.rb

@@ -1,5 +1,4 @@
 class User < ActiveRecord::Base
-  include GlobalHelpers
 
   ##
   # Devise
@@ -20,6 +19,7 @@ class User < ActiveRecord::Base
   has_and_belongs_to_many :perms, join_table: :users_perms
   belongs_to :language
   belongs_to :org
+  has_one  :pref
   has_many :answers
   has_many :notes
   has_many :exported_plans
@@ -42,24 +42,8 @@ def filter(query)
   has_many :user_identifiers
   has_many :identifier_schemes, through: :user_identifiers
 
-  ##
-  # Possibly needed for active_admin
-  #   -relies on protected_attributes gem as syntax depricated in rails 4.2
-  #accepts_nested_attributes_for :roles
-  #attr_accessible :password_confirmation, :encrypted_password, :remember_me,
-  #                :id, :email, :firstname, :last_login,:login_count, :orcid_id,
-  #                :password, :shibboleth_id, :user_status_id, :surname,
-  #                :user_type_id, :org_id, :skip_invitation, :other_organisation,
-  #                :accept_terms, :role_ids, :dmponline3, :api_token,
-  #                :organisation, :language, :language_id, :org, :perms,
-  #                :confirmed_at, :org_id
-
   validates :email, email: true, allow_nil: true, uniqueness: {message: _("must be unique")}
 
-
-  validates :prefs, presence: true
-  before_validation :create_default_preferences
-
   ##
   # Scopes
   default_scope { includes(:org, :perms, :plans) }
@@ -222,17 +206,6 @@ def can_grant_api_to_orgs?
     perms.include? Perm.grant_api
   end
 
-  ##
-  # checks what type the user's organisation is
-  #
-  # @return [String] the organisation type
-=begin
-  def org_type
-    org_type = org.organisation_type
-    return org_type
-  end
-=end
-
   ##
   # removes the api_token from the user
   # modifies the user model
@@ -272,54 +245,23 @@ def self.from_omniauth(auth)
     end
   end
 
+  ##
+  # Return the user's preferences for a given base key
+  #
+  # @return [JSON] with symbols as keys
+  def get_preferences(key)
+    if self.pref.present? && self.pref.settings[key.to_s].present?
+      return self.pref.settings[key.to_s].deep_symbolize_keys
+    else
+      return Pref.default_settings[key]
+    end
+  end
+
   ##
   # Override devise_invitable email title
   # --------------------------------------------------------------
   def deliver_invitation(options = {})
     super(options.merge(subject: _('A Data Management Plan in %{application_name} has been shared with you') % {application_name: Rails.configuration.branding[:application][:name]}))
   end
 
-
-  ##
-  # User Notification Preferences
-  def create_default_preferences
-    # Set the default preferences for a new user or if existing user if null
-    if self.id.nil? || self.prefs == {}
-      self.prefs = self.class.create_default_preferences
-    end
-  end
-
-  def self.create_default_preferences
-    default_prefs = {
-        users:           {
-            new_comment: true,
-            admin_privileges: true,
-            added_as_coowner: true
-        },
-        owners_and_coowners:       {
-            visibility_changed:   true
-        },
-        admins:      {
-            template_published:  true,
-            template_unpublished: true,
-            feedback_requested: true
-        }
-    }
-  end
-
-# TODO: Remove this, its never called.
-  # this generates a reset password link for a given user
-  # which can then be sent to them with the appropriate host
-  # prepended.
-=begin
-  def reset_password_link
-    raw, enc = Devise.token_generator.generate(self.class, :reset_password_token)
-    self.reset_password_token   = enc
-    self.reset_password_sent_at = Time.now.utc
-    save(validate: false)
-
-    edit_user_password_path  + '?reset_password_token=' + raw
-  end
-=end
-
 end

config/branding_example.yml

@@ -17,6 +17,19 @@ defaults: &defaults
     issue_list_url: 'https://github.com/DMPRoadmap/roadmap/issues'
     user_group_subscription_url: 'http://listserv.ucop.edu/cgi-bin/wa.exe?SUBED1=ROADMAP-L&A=1'
 
+  preferences:
+    email:
+      users:
+        new_comment: true
+        admin_privileges: true
+        added_as_coowner: true
+      owners_and_coowners:
+        visibility_changed: true
+      admins:
+        template_published: true
+        template_unpublished: true
+        feedback_requested: true
+
 development:
   <<: *defaults
 

config/routes.rb

@@ -39,7 +39,6 @@
     get "/users/sign_out", :to => "devise/sessions#destroy"
   end
 
-  match '/users/update_preferences/' => 'users#update_preferences',  as: 'user_update_preferences', via: [:put, :post]
 
   # WAYFless access point - use query param idp
   #get 'auth/shibboleth' => 'users/omniauth_shibboleth_request#redirect', :as => 'user_omniauth_shibboleth'
@@ -57,7 +56,11 @@
   get '/orgs/shibboleth/:org_name', to: 'orgs#shibboleth_ds_passthru'
   post '/orgs/shibboleth', to: 'orgs#shibboleth_ds_passthru'
 
-  #ActiveAdmin.routes(self)
+  resources :users, path: 'users', only: [] do
+    member do
+      put 'update_email_preferences'
+    end
+  end
 
   #organisation admin area
   resources :users, :path => 'org/admin/users', only: [] do
@@ -220,34 +223,6 @@
       end
     end
 
-#    resources :projects do
-#      resources :plans , only: [:edit, :update] do
-#        member do
-#          get 'status'
-#          get 'locked'
-#          get 'answer'
-#          #get 'edit'
-#          post 'delete_recent_locks'
-#          post 'lock_section', constraints: {format: [:html, :json]}
-#          post 'unlock_section', constraints: {format: [:html, :json]}
-#          post 'unlock_all_sections'
-#          get 'export'
-#          get 'warning'
-#          get 'section_answers'
-#        end
-#      end
-#
-#      member do
-#        get 'share'
-#        get 'export'
-#        post 'invite'
-#      end
-#      collection do
-#        get 'possible_templates'
-#        get 'possible_guidance'
-#      end
-#    end
-
     resources :roles, only: [:create, :update, :destroy]
 
     namespace :settings do
@@ -272,57 +247,4 @@
       end
     end
 
-    # The priority is based upon order of creation:
-    # first created -> highest priority.
-
-    # Sample of regular route:
-    #   match 'products/:id' => 'catalog#view'
-    # Keep in mind you can assign values other than :controller and :action
-
-    # Sample of named route:
-    #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
-    # This route can be invoked with purchase_url(:id => product.id)
-
-    # Sample resource route (maps HTTP verbs to controller actions automatically):
-    #   resources :products
-
-    # Sample resource route with options:
-    #   resources :products do
-    #     member do
-    #       get 'short'
-    #       post 'toggle'
-    #     end
-    #
-    #     collection do
-    #       get 'sold'
-    #     end
-    #   end
-
-    # Sample resource route with sub-resources:
-    #   resources :products do
-    #     resources :comments, :sales
-    #     resource :seller
-    #   end
-
-    # Sample resource route with more complex sub-resources
-    #   resources :products do
-    #     resources :comments
-    #     resources :sales do
-    #       get 'recent', :on => :collection
-    #     end
-    #   end
-
-    # Sample resource route within a namespace:
-    #   namespace :admin do
-    #     # Directs /admin/products/* to Admin::ProductsController
-    #     # (app/controllers/admin/products_controller.rb)
-    #     resources :products
-    #   end
-
-
-    # See how all your routes lay out with "rake routes"
-
-    # This is a legacy wild controller route that's not recommended for RESTful applications.
-    # Note: This route will make all actions in every controller accessible via GET requests.
-    # match ':controller(/:action(/:id))(.:format)'
 end

db/migrate/20170712084314_move_prefs_to_table.rb

@@ -0,0 +1,12 @@
+class MovePrefsToTable < ActiveRecord::Migration
+  def change
+    remove_column :users, :prefs
+
+    create_table :prefs do |t|
+      t.string :settings
+      t.integer :user_id
+    end
+  end
+end
+
+