Refactor vehicle model: streamline search functionality using built in modules

app/models/vehicle.rb

@@ -10,115 +10,24 @@
 
 class Vehicle < ActiveRecord::Base
 
+  include Redmine::Acts::Searchable
+  include Redmine::Acts::Event
+
   belongs_to :customer
   has_many :issues
   validates_presence_of :customer
   validates :vin, uniqueness: true
   before_save :decode_vin
 
-  def self.searchable_columns
+  acts_as_searchable columns: %w[vin make model year],
-    ['vin', 'make', 'model', 'year']
+                     scope: ->(_context) { left_joins(:project) },
-  end
+                     date_column: :updated_at
 
-  def self.searchable_options
+  acts_as_event :title => Proc.new {|o| "#{o.to_s}"},
-    {
+                :url => Proc.new {|o| { :controller => 'vehicles', :action => 'show', :id => o.id} },
-      columns: searchable_columns,
+                :type => :to_s,
-      scope: self.all
+                :description => Proc.new {|o| "#{o.vin} - #{o.customer}"},
-    }
+                :datetime => Proc.new {|o| o.updated_at || o.created_at}
-  end
-
-  def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
-    return {} if tokens.blank?
-
-    scope = self.all
-
-    tokens.each do |token|
-      q = "%#{sanitize_sql_like(token)}%"
-      scope = where("vin LIKE ? OR make LIKE ? OR model LIKE ? OR year LIKE ?", "%#{q}%", "%#{q}%", "%#{q}%", "%#{q}%") 
-    end
-
-    ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
-
-    # Assign simple uniform ranking
-    ids.each_with_object({}) { |id, h| h[id] = id }
-  end
-
-  def self.search_results_from_ids(ids, *args)
-    return [] if ids.blank?
-
-    Rails.logger.warn "IDS: #{ids.inspect}"
-
-    ids = ids.map(&:to_i)
-    records = where(id: ids).index_by(&:id)
-    ids.map { |id| records[id] }.compact
-  end
-  
-  # ---- Redmine Search Event Interface ----
-  def event_type
-    'vehicle'
-  end
-
-  def event_title
-    to_s
-  end
-
-  def event_description
-    "#{vin} - #{customer}"
-  end
-
-  def event_url
-    Rails.application.routes.url_helpers.vehicle_path(self)
-  end
-
-  def event_datetime
-    updated_at || created_at
-  end
-
-  def project
-    # Vehicles are not project scoped in your schema.
-    # Return nil so global search works cleanly.
-    nil
-  end
-
-  # returns a human readable string
-  def to_s
-    if year.nil? or make.nil? or model.nil?
-      return "#{vin}"
-    else
-      split_vin = vin.scan(/.{1,9}/)
-      return "#{year} #{make} #{model} - #{split_vin[1]}"
-    end
-  end
-  
-  # returns the raw JSON details from NHTSA
-  def details
-    get_details if @details.nil?
-    return @details
-  end
-  
-  # Force Upper Case for make numbers
-  def make=(val)
-    # The to_s is in case you get nil/non-string
-    write_attribute(:make, val.to_s.titleize)
-  end
-  
-  # Force Upper Case for model numbers
-  def model=(val)
-    # The to_s is in case you get nil/non-string
-    write_attribute(:model, val.to_s.titleize)
-  end
-  
-  # Force Upper Case & strip VIN of all illegal chars (for barcode scanner)
-  def vin=(val)
-    val = val.to_s.upcase.gsub(/[^A-HJ-NPR-Za-hj-npr-z\d]+/,"")
-    write_attribute(:vin, val)
-  end
-  
-  # search for a vehicle by vin, make, model, or year
-  def self.search(query)
-    q = sanitize_sql_like(query)
-    where("vin LIKE ? OR make LIKE ? OR model LIKE ? OR year LIKE ?", "%#{q}%", "%#{q}%", "%#{q}%", "%#{q}%") 
-  end
 
   # decodes a vin and updates self
   def decode_vin
@@ -137,9 +46,10 @@ class Vehicle < ActiveRecord::Base
     self.name = to_s
   end
 
-  # reurns all invoices for this vehicle
+  # returns the raw JSON details from NHTSA
-  def invoices
+  def details
-    self.issues.flat_map(&:invoices).uniq.compact
+    get_details if @details.nil?
+    return @details
   end
 
   # returns all estimates for this vehicle
@@ -147,6 +57,67 @@ class Vehicle < ActiveRecord::Base
     self.issues.flat_map(&:estimate).uniq.compact
   end
 
+  # reurns all invoices for this vehicle
+  def invoices
+    self.issues.flat_map(&:invoices).uniq.compact
+  end
+  
+  # Force Upper Case for make numbers
+  def make=(val)
+    # The to_s is in case you get nil/non-string
+    write_attribute(:make, val.to_s.titleize)
+  end
+  
+  # Force Upper Case for model numbers
+  def model=(val)
+    # The to_s is in case you get nil/non-string
+    write_attribute(:model, val.to_s.titleize)
+  end
+  
+  # needed for redmine's search and event system, but we don't want to tie vehicles to projects
+  def project
+    nil
+  end
+
+  # search for a vehicle by vin, make, model, or year
+  def self.search(query)
+    q = sanitize_sql_like(query)
+    where("vin LIKE ? OR make LIKE ? OR model LIKE ? OR year LIKE ?", "%#{q}%", "%#{q}%", "%#{q}%", "%#{q}%") 
+  end
+
+  # Override the defult redmine seach method to rank results by id
+  def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
+    return {} if tokens.blank?
+
+    scope = self.all
+
+    tokens.each do |token|
+      q = "%#{sanitize_sql_like(token)}%"
+      scope = where("vin LIKE ? OR make LIKE ? OR model LIKE ? OR year LIKE ?", "%#{q}%", "%#{q}%", "%#{q}%", "%#{q}%") 
+    end
+
+    ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
+
+    # rank by id
+    ids.each_with_object({}) { |id, h| h[id] = id }
+  end
+
+  # returns a human readable string
+  def to_s
+    if year.nil? or make.nil? or model.nil?
+      return "#{vin}"
+    else
+      split_vin = vin.scan(/.{1,9}/)
+      return "#{year} #{make} #{model} - #{split_vin[1]}"
+    end
+  end
+
+  # Force Upper Case & strip VIN of all illegal chars (for barcode scanner)
+  def vin=(val)
+    val = val.to_s.upcase.gsub(/[^A-HJ-NPR-Za-hj-npr-z\d]+/,"")
+    write_attribute(:vin, val)
+  end
+  
   private
   
   # init method to pull JSON details from NHTSA