blacklight-spotlight 0.4.1 → 0.5.0

data/app/jobs/spotlight/reindex_job.rb

@@ -1,19 +1,19 @@
 module Spotlight
+  ##
+  # Reindex the given resources or exhibits
   class ReindexJob < ActiveJob::Base
     queue_as :default
 
     def perform(exhibit_or_resources)
       resources = if exhibit_or_resources.is_a? Spotlight::Exhibit
-        exhibit_or_resources.resources.find_each
-      elsif exhibit_or_resources.is_a? Enumerable
-        exhibit_or_resources
-      else
-        Array(exhibit_or_resources)
-      end
+                    exhibit_or_resources.resources.find_each
+                  elsif exhibit_or_resources.is_a? Enumerable
+                    exhibit_or_resources
+                  else
+                    Array(exhibit_or_resources)
+                  end
 
-      resources.each do |r|
-        r.reindex
-      end
+      resources.each(&:reindex)
     end
   end
 end

data/app/jobs/spotlight/rename_sidecar_field_job.rb

@@ -1,4 +1,7 @@
 module Spotlight
+  ##
+  # After renaming an exhibit-specific field, we also
+  # need to update the sidecars that may contain that field
   class RenameSidecarFieldJob < ActiveJob::Base
     queue_as :default
 

data/app/mailers/spotlight/confirmation_mailer.rb

@@ -1,4 +1,6 @@
 module Spotlight
+  ##
+  # Confirm new devise users
   class ConfirmationMailer < ActionMailer::Base
     include Devise::Mailers::Helpers
 

data/app/mailers/spotlight/indexing_complete_mailer.rb

@@ -1,10 +1,12 @@
 module Spotlight
+  ##
+  # Notify the curator that we're finished processing a
+  # batch upload
   class IndexingCompleteMailer < ActionMailer::Base
-
     def documents_indexed(csv_data, exhibit, user)
       @number = csv_data.length
       @exhibit = exhibit
-      mail(to: user.email, subject: "Document indexing complete")
+      mail(to: user.email, subject: 'Document indexing complete')
     end
   end
 end

data/app/models/ability.rb

@@ -1,3 +1,6 @@
+##
+# Default Cancan ability implementation; this should be overridden by
+# downstream application
 class Ability
   include Spotlight::Ability
 end

data/app/models/concerns/spotlight/ar_light.rb

@@ -1,4 +1,7 @@
 module Spotlight
+  ##
+  # Stub ActiveRecord methods to allow non-ActiveRecord::Base objects to
+  # participate in e.g. associations
   module ArLight
     extend ActiveSupport::Concern
     include ActiveRecord::ModelSchema
@@ -7,6 +10,8 @@ module Spotlight
     include ActiveRecord::Reflection
     include ActiveModel::Dirty
 
+    ##
+    # Mock activerecord class-level methods
     module ClassMethods
       def base_class
         self
@@ -16,30 +21,7 @@ module Spotlight
       def subclass_from_attributes?(_)
         false
       end
-    end
-
-    def initialize (source_doc={}, solr_response=nil)
-      @association_cache = {}
-      super
-    end
 
-    # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
-    # is of the same type and +self+ has an ID and it is equal to +comparison_object.id+.
-    #
-    # Note that new records are different from any other record by definition, unless the
-    # other record is the receiver itself. Besides, if you fetch existing records with
-    # +select+ and leave the ID out, you're on your own, this predicate will return false.
-    #
-    # Note also that destroying a record preserves its ID in the model instance, so deleted
-    # models are still comparable.
-    def ==(comparison_object)
-      super ||
-        comparison_object.instance_of?(self.class) &&
-        id &&
-        comparison_object.id == id
-    end
-      
-    module ClassMethods
       def generated_feature_methods
         @generated_feature_methods ||= begin
           mod = const_set(:GeneratedFeatureMethods, Module.new)
@@ -48,16 +30,58 @@ module Spotlight
         end
       end
 
-      def before_destroy *args
+      def before_destroy(*_args)
       end
 
       def pluralize_table_names
         true
       end
 
-      def add_autosave_association_callbacks arg
+      def add_autosave_association_callbacks(_arg)
+      end
+
+      # needed for Rails 4.1 + act_as_taggable
+      def dangerous_attribute_method?(*_args)
+        false
+      end
+
+      # needed for Rails 4.1 + act_as_taggable
+      def generated_association_methods
+        @generated_association_methods ||= begin
+          mod = const_set(:GeneratedAssociationMethods, Module.new)
+          include mod
+          mod
+        end
       end
 
+      def validators_on(*_)
+        []
+      end
+
+      def default_scopes
+        []
+      end
+    end
+
+    def initialize(source_doc = {}, solr_response = nil)
+      @association_cache = {}
+      super
+    end
+
+    # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
+    # is of the same type and +self+ has an ID and it is equal to +comparison_object.id+.
+    #
+    # Note that new records are different from any other record by definition, unless the
+    # other record is the receiver itself. Besides, if you fetch existing records with
+    # +select+ and leave the ID out, you're on your own, this predicate will return false.
+    #
+    # Note also that destroying a record preserves its ID in the model instance, so deleted
+    # models are still comparable.
+    def ==(other)
+      super ||
+        (other.instance_of?(self.class) &&
+          id &&
+          other.id == id)
     end
   end
 end

data/app/models/concerns/spotlight/blacklight_configuration_defaults.rb

@@ -1,26 +1,41 @@
-module Spotlight::BlacklightConfigurationDefaults
-  extend ActiveSupport::Concern
-
-  included do
-    before_create :setup_defaults
-  end
+module Spotlight
+  ##
+  # Helpers to provide default blacklight configuration values
+  module BlacklightConfigurationDefaults
+    extend ActiveSupport::Concern
+
+    included do
+      before_create :setup_defaults
+    end
 
+    protected
 
-  protected
     def setup_defaults
+      default_search_fields
       default_sort_fields
       default_view_types
       set_default_per_page
     end
 
+    def default_search_fields
+      return true unless search_fields.empty?
+
+      # can't use default_blacklight_config until after the BlacklightConfiguration
+      # is created or we run into a circular dependency.
+      default_fields = Spotlight::Engine.blacklight_config.search_fields
+      self.search_fields = default_fields.each_with_object({}) do |(k, _v), obj|
+        obj[k] = { enabled: true }
+      end
+    end
+
     def default_sort_fields
       return true unless sort_fields.empty?
 
       # can't use default_blacklight_config until after the BlacklightConfiguration
       # is created or we run into a circular dependency.
       default_fields = Spotlight::Engine.blacklight_config.sort_fields
-      self.sort_fields = default_fields.each_with_object({}) do |(k, v), obj|
-        obj[k] = { show: true }
+      self.sort_fields = default_fields.each_with_object({}) do |(k, _v), obj|
+        obj[k] = { enabled: true }
       end
     end
 
@@ -37,5 +52,5 @@ module Spotlight::BlacklightConfigurationDefaults
       # is created or we run into a circular dependency.
       self.default_per_page ||= Spotlight::Engine.blacklight_config.per_page.first
     end
-
+  end
 end

data/app/models/concerns/spotlight/exhibit_analytics.rb

@@ -0,0 +1,28 @@
+module Spotlight
+  ##
+  # Exhibit mixin to provide analytics data
+  module ExhibitAnalytics
+    def analytics(start_date = 1.month, path = nil)
+      return OpenStruct.new unless analytics_provider && analytics_provider.enabled?
+      @analytics ||= {}
+      @analytics[start_date] ||= begin
+        analytics_provider.exhibit_data(path || self, start_date: start_date.ago)
+      end
+    end
+
+    def page_analytics(start_date = 1.month, path = nil)
+      return [] unless analytics_provider && analytics_provider.enabled?
+
+      @page_analytics ||= {}
+      @page_analytics[start_date] ||= begin
+        analytics_provider.page_data(path || self, start_date: start_date.ago)
+      end
+    end
+
+    private
+
+    def analytics_provider
+      Spotlight::Engine.config.analytics_provider
+    end
+  end
+end

data/app/models/concerns/spotlight/image_derivatives.rb

@@ -1,22 +1,21 @@
-###
- # Include Spotlight::ImageDerivatives in a class or module to get
- # the derivative configurations in #spotlight_image_derivatives.
- # A new derivative could theoretically be added by putting the
- # following in an initializer.
- # Spotlight::ImageDerivatives.spotlight_image_derivatives << {
- #   version: :my_version,
- #   field: :my_field,
- #   lambda: lambda {|_|
- #     version :my_version do
- #       process :resize_to_fill => [30,30]
- #     end
- #   }
- # }
- #
- # This will then create that new CarrierWave version in any class that extends this module
- # and calls the apply_spotlight_image_derivative_versions class method described below.
-###
 module Spotlight
+  ###
+  # Include Spotlight::ImageDerivatives in a class or module to get
+  # the derivative configurations in #spotlight_image_derivatives.
+  # A new derivative could theoretically be added by putting the
+  # following in an initializer.
+  # Spotlight::ImageDerivatives.spotlight_image_derivatives << {
+  #   version: :my_version,
+  #   field: :my_field,
+  #   lambda: lambda {|_|
+  #     version :my_version do
+  #       process :resize_to_fill => [30,30]
+  #     end
+  #   }
+  # }
+  #
+  # This will then create that new CarrierWave version in any class that extends this module
+  # and calls the apply_spotlight_image_derivative_versions class method described below.
   module ImageDerivatives
     mattr_accessor :spotlight_image_derivatives
 
@@ -25,7 +24,7 @@ module Spotlight
     # configured versions will be available
     def apply_spotlight_image_derivative_versions
       spotlight_image_derivatives.each do |version_config|
-        if(c = version_config[:lambda]).present?
+        if (c = version_config[:lambda]).present?
           class_eval(&c)
         end
       end
@@ -39,21 +38,21 @@ module Spotlight
       {
         version: :thumb,
         field: Spotlight::Engine.config.try(:thumbnail_field),
-        lambda: lambda {|_|
+        lambda: lambda do|_|
           version :thumb do
-            process :resize_to_fit => [400,400]
+            process resize_to_fit: [400, 400]
           end
-        }
+        end
       },
       {
         version: :square,
         field: Spotlight::Engine.config.try(:square_image_field),
-        lambda: lambda {|_|
+        lambda: lambda do|_|
           version :square do
-            process :resize_to_fill => [100,100]
+            process resize_to_fill: [100, 100]
           end
-        }
+        end
       }
-    ].reject{|v| v[:field].blank? }
+    ].reject { |v| v[:field].blank? }
   end
 end

data/app/models/concerns/spotlight/resources/open_graph.rb

@@ -1,28 +1,32 @@
-module Spotlight::Resources
-  module OpenGraph
-    extend ActiveSupport::Concern
-    include Spotlight::Resources::Web
+module Spotlight
+  module Resources
+    ##
+    # OpenGraph metadata harvester
+    module OpenGraph
+      extend ActiveSupport::Concern
+      include Spotlight::Resources::Web
 
-    def opengraph
-      @opengraph ||= begin
-        page = Hash.new
+      def opengraph
+        @opengraph ||= begin
+          page = {}
 
-        body.css('meta').select { |m| m.attribute('property') }.each do |m|
-          page[m.attribute('property').to_s] = m.attribute('content').to_s
-        end
+          body.css('meta').select { |m| m.attribute('property') }.each do |m|
+            page[m.attribute('property').to_s] = m.attribute('content').to_s
+          end
 
-        page
+          page
+        end
       end
-    end
 
-    def opengraph_properties
-      Hash[opengraph.map do |k,v|
-        ["#{k.parameterize("_")}_tesim", v]
-      end]
-    end
+      def opengraph_properties
+        Hash[opengraph.map do |k, v|
+          ["#{k.parameterize('_')}_tesim", v]
+        end]
+      end
 
-    def to_solr
-      super.merge(opengraph_properties)
+      def to_solr
+        super.merge(opengraph_properties)
+      end
     end
   end
 end

data/app/models/concerns/spotlight/resources/web.rb

@@ -1,35 +1,36 @@
 require 'nokogiri'
 
-module Spotlight::Resources
-  module Web
-    extend ActiveSupport::Concern
+module Spotlight
+  module Resources
+    ##
+    # Generic web resource harvester base module
+    module Web
+      extend ActiveSupport::Concern
 
-    included do
-      before_create do
-        harvest!
+      included do
+        before_create do
+          harvest!
+        end
       end
-    end
-
-    def harvest!
-      response = Spotlight::Resources::Web.fetch url
-      self.data[:headers] = response.headers
-      self.data[:body] = response.body
-    end
 
-    def body
-      if data[:body].blank?
-        harvest!
+      def harvest!
+        response = Spotlight::Resources::Web.fetch url
+        data[:headers] = response.headers
+        data[:body] = response.body
       end
 
-      @body ||= Nokogiri::HTML.parse data[:body]
-    end
+      def body
+        harvest! if data[:body].blank?
 
-    def self.fetch url
-      Faraday.new(url) do |b|
-        b.use FaradayMiddleware::FollowRedirects
-        b.adapter :net_http
-      end.get
-    end
+        @body ||= Nokogiri::HTML.parse data[:body]
+      end
 
+      def self.fetch(url)
+        Faraday.new(url) do |b|
+          b.use FaradayMiddleware::FollowRedirects
+          b.adapter :net_http
+        end.get
+      end
+    end
   end
 end