Merge pull request #1175 from projectblacklight/am-shim

ActiveModel shimming

Author: jcoyne

app/helpers/blacklight/catalog_helper_behavior.rb

@@ -48,9 +48,12 @@ def page_entries_info(collection, options = {})
   #
   # @param [Integer] document index
   # @return [Integer]
-  def document_counter_with_offset idx 
+  def document_counter_with_offset idx, offset = nil
+    offset ||= @response.start if @response
+    offset ||= 0
+
     unless render_grouped_response? 
-      idx + 1 + @response.params[:start].to_i
+      idx + 1 + offset
     end
   end
 

lib/blacklight/document.rb

@@ -13,6 +13,7 @@
 # transformation formats.
 #
 module Blacklight::Document
+  autoload :ActiveModelShim, 'blacklight/document/active_model_shim'
   autoload :SchemaOrg, 'blacklight/document/schema_org'
   autoload :DublinCore, 'blacklight/document/dublin_core'
   autoload :Email, 'blacklight/document/email'
@@ -42,14 +43,6 @@ def initialize(source_doc={}, response=nil)
     apply_extensions
   end
 
-  def to_model
-    self
-  end
-
-  def persisted?
-    true
-  end
-
   # the wrapper method to the @_source object.
   # If a method is missing, it gets sent to @_source
   # with all of the original params and block
@@ -65,14 +58,6 @@ def respond_to_missing? *args
     _source_responds_to?(*args) || super
   end
 
-  def [] *args
-    _source.send :[], *args
-  end
-
-  def _read_attribute(attr)
-    self[attr]
-  end
-
   # Helper method to check if value/multi-values exist for a given key.
   # The value can be a string, or a RegExp
   # Multiple "values" can be given; only one needs to match.
@@ -138,30 +123,10 @@ def first key
     Array(self[key]).first
   end
 
-  def id
-    self[self.class.unique_key]
-  end
-
-  def to_param
-    id.to_s
-  end
-
-  def as_json(options = nil)
-    _source.as_json(options)
-  end
-
   def to_partial_path
     'catalog/document'
   end
 
-  def destroyed?
-    false
-  end
-  
-  def new_record?
-    false
-  end
-  
   def has_highlight_field? k
     false
   end
@@ -186,13 +151,6 @@ def unique_key
       @unique_key ||= 'id' 
     end
 
-    def primary_key
-      unique_key
-    end
-    
-    def base_class
-      self
-    end  
   end
 
   private

lib/blacklight/document/active_model_shim.rb

@@ -0,0 +1,62 @@
+require 'active_model/conversion'
+
+module Blacklight::Document
+  module ActiveModelShim
+    extend ActiveSupport::Concern
+
+    include ::ActiveModel::Conversion
+
+    module ClassMethods
+      def primary_key
+        unique_key
+      end
+
+      def base_class
+        self
+      end
+    end
+    
+    ##
+    # Unique ID for the document
+    def id
+      self[self.class.unique_key]
+    end
+
+    ##
+    # accessors for reading attribute
+    def [] *args
+      _source.send :[], *args
+    end
+    
+    def _read_attribute(attr)
+      self[attr]
+    end
+
+    def as_json(options = nil)
+      _source.as_json(options)
+    end
+    
+    ##
+    # ActiveRecord::Persistence method stubs to get non-AR objects to
+    # play nice with e.g. Blacklight's bookmarks
+    def persisted?
+      true
+    end
+
+    def destroyed?
+      false
+    end
+    
+    def new_record?
+      false
+    end
+
+    ##
+    # #to_partial_path is also defined in Blacklight::Document, but
+    # ActiveModel::Conversion (included above) will overwrite that..
+    def to_partial_path
+      'catalog/document'
+    end
+
+  end
+end

lib/blacklight/solr/document.rb

@@ -26,6 +26,7 @@ module Blacklight::Solr::Document
 
   extend ActiveSupport::Concern
   include Blacklight::Document
+  include Blacklight::Document::ActiveModelShim
   include Blacklight::Solr::Document::MoreLikeThis
 
   def has_highlight_field? k

lib/blacklight/solr_response.rb

@@ -34,6 +34,10 @@ def params
     header['params'] || request_params
   end
 
+  def start
+    params[:start].to_i
+  end
+
   def rows
     params[:rows].to_i
   end

spec/helpers/blacklight_helper_spec.rb

@@ -462,7 +462,7 @@ def mock_document_app_helper_url *args
 
     before do
       allow(helper).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
-      assign(:response, double("SolrResponse", grouped?: false, params: {}))
+      assign(:response, double("SolrResponse", grouped?: false, start: 0))
       allow(helper).to receive(:link_to_document).and_return('<a/>')
       allow(helper).to receive(:render_index_doc_actions).and_return('<div/>')
     end

spec/helpers/catalog_helper_spec.rb

@@ -247,19 +247,19 @@ def render_grouped_response?
 
   describe "document_counter_with_offset" do
     it "should render the document index with the appropriate offset" do
-      assign(:response, double(:params => { :start => 0 }, :grouped? => false))
+      assign(:response, double(start: 0, grouped?: false))
       expect(helper.document_counter_with_offset(0)).to be(1)
       expect(helper.document_counter_with_offset(1)).to be(2)
     end
 
     it "should render the document index with the appropriate offset" do
-      assign(:response, double(:params => { :start => 10 }, :grouped? => false))
+      assign(:response, double(start: 10, grouped?: false))
       expect(helper.document_counter_with_offset(0)).to be(11)
       expect(helper.document_counter_with_offset(1)).to be(12)
     end
 
     it "should not provide a counter for grouped responses" do
-      assign(:response, double(:params => { :start => 10 }, :grouped? => true))
+      assign(:response, double(start: 10, grouped?: true))
       expect(helper.document_counter_with_offset(0)).to be_nil
     end
   end

spec/views/catalog/_index_header_default.html.erb_spec.rb

@@ -10,7 +10,7 @@
   end
 
   before do
-    assign :response, double(params: {})
+    assign :response, double(start: 0)
     allow(view).to receive(:render_grouped_response?).and_return false
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     allow(view).to receive(:current_search_session).and_return nil

spec/views/catalog/_thumbnail_default.erb_spec.rb

@@ -17,7 +17,7 @@
   end
 
   before do
-    assign :response, double(:params => {})
+    assign :response, double(start: 0)
     allow(view).to receive(:render_grouped_response?).and_return false
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     allow(view).to receive(:current_search_session).and_return nil