acts_as_sourceable 2.0.0 → 2.1.0

data/README.md

@@ -0,0 +1,25 @@
+# ActsAsSourceable
+
+Allows the RRN to perform garbage project on categories that are no longer referenced.
+
+## Installation
+
+### In your gemfile
+```ruby
+gem 'acts_as_sourceable'
+```
+
+### Migration
+```ruby
+create_table :acts_as_sourceable_registry do |t|
+  t.belongs_to :sourceable, :polymorphic => true
+  t.belongs_to :source, :polymorphic => true
+  t.timestamps
+end
+
+add_index :acts_as_sourceable_registry, [:sourceable_id, :sourceable_type], :name => :index_acts_as_sourceable_sourceables
+add_index :acts_as_sourceable_registry, [:source_id, :source_type], :name => :index_acts_as_sourceable_sources
+
+```
+
+## Usage

data/lib/acts_as_sourceable/acts_as_sourceable.rb

@@ -15,8 +15,8 @@ module ActsAsSourceable
         if acts_as_sourceable_options[:through]
           def sources; send(acts_as_sourceable_options[:through]) || []; end
         else
-          has_one :sourceable_institution, :class_name => 'ActsAsSourceable::Registry', :as => :sourceable, :dependent => :delete
-          def sources; sourceable_institution.try(:sources) || []; end
+          has_many :sourceable_registry_entries, :class_name => 'ActsAsSourceable::RegistryEntry', :as => :sourceable, :dependent => :delete_all
+          def sources; self.sourceable_registry_entries.includes(:source).collect(&:source); end
         end
       end
 
@@ -25,7 +25,7 @@ module ActsAsSourceable
 
       # If a cache column is provided, use that to determine which records are sourced and unsourced
       # Elsif the records can be derived, we need to check the flattened item tables for any references
-      # Else we check the sourceable_institutions to see if the record has a recorded source
+      # Else we check the registry_entries to see if the record has a recorded source
       if options[:cache_column]
         scope :sourced, where(options[:cache_column] => true)
         scope :unsourced, where(options[:cache_column] => false)
@@ -33,25 +33,18 @@ module ActsAsSourceable
         scope :sourced, joins(options[:through]).uniq
         scope :unsourced, joins("LEFT OUTER JOIN (#{sourced.to_sql}) sourced ON sourced.id = #{table_name}.id").where("sourced.id IS NULL")
       else
-        scope :sourced, joins(:sourceable_institution)
+        scope :sourced, joins(:sourceable_registry_entries).uniq
         scope :unsourced, joins("LEFT OUTER JOIN (#{sourced.to_sql}) sourced ON sourced.id = #{table_name}.id").where("sourced.id IS NULL")
       end
 
       # Add a way of finding everything sourced by a particular set of records
       if options[:through]
-        def sourced_by(*sources)
-          raise NotImplementedError # TODO
+        def self.sourced_by(source)
+          self.joins(acts_as_sourceable_options[:through]).where(reflect_on_association(acts_as_sourceable_options[:through]).table_name => {:id => source.id})
         end
       else
-        def sourced_by(*sources)
-          holding_institution_ids, collection_ids, item_ids = ActsAsSourceable::HelperMethods.group_ids_by_class(sources)
-
-          arel_table = ActsAsSourceable::Registry.arel_table
-          h_contraint = arel_table[:holding_institution_ids].array_overlap(holding_institution_ids)
-          c_contraint = arel_table[:collection_ids].array_overlap(collection_ids)
-          i_contraint = arel_table[:item_ids].array_overlap(item_ids)
-
-          sourced.where(h_contraint.or(c_contraint).or(i_contraint))
+        def self.sourced_by(source)
+          self.joins(:sourceable_registry_entries).where(ActsAsSourceable::RegistryEntry.table_name => {:source_type => source.class, :source_id => source.id}).uniq
         end
       end
 
@@ -86,7 +79,7 @@ module ActsAsSourceable
     
     def unsource
       scoping { @klass.update_all("#{acts_as_sourceable_options[:cache_column]} = false", @klass.acts_as_sourceable_options[:cache_column] => true) } if @klass.acts_as_sourceable_options[:cache_column]
-      scoping { ActsAsSourceable::Registry.where("sourceable_type = ? AND sourceable_id IN (#{@klass.select("#{@klass.table_name}.id").to_sql})", @klass.name).delete_all }
+      scoping { ActsAsSourceable::RegistryEntry.where("sourceable_type = ? AND sourceable_id IN (#{@klass.select("#{@klass.table_name}.id").to_sql})", @klass.name).delete_all }
     end
   end
 
@@ -115,94 +108,73 @@ module ActsAsSourceable
 
     # Add the given holding_institutions, collections, and items
     def add_sources(*sources)
-      holding_institution_ids, collection_ids, item_ids = ActsAsSourceable::HelperMethods.group_ids_by_class(sources)
-      registry = init_registry_entry
-      set_sources(registry.holding_institution_ids + holding_institution_ids, registry.collection_ids + collection_ids, registry.item_ids + item_ids)
+      raise "Cannot set sources of a #{self.class.name}. They are sourced through #{acts_as_sourceable_options[:through]}" if acts_as_sourceable_options[:through]
+
+      sources = Array(sources).flatten
+      sources.each do |source|
+        source_scope(source).first_or_create!
+      end
+      update_sourceable_cache_column(true) if sources.present?
     end
     alias_method :add_source, :add_sources
 
     # Remove the given holding_institutions, collections, and items
     def remove_sources(*sources)
-      holding_institution_ids, collection_ids, item_ids = ActsAsSourceable::HelperMethods.group_ids_by_class(sources)
-      registry = init_registry_entry
-      set_sources(registry.holding_institution_ids - holding_institution_ids, registry.collection_ids - collection_ids, registry.item_ids - item_ids)
-    end
-    alias_method :remove_source, :remove_sources
+      raise "Cannot set sources of a #{self.class.name}. They are sourced through #{acts_as_sourceable_options[:through]}" if acts_as_sourceable_options[:through]
 
-    # Record which holding_institution, collection, and optionally which item the record came from
-    # If the record has no sources, the sourceable institution is deleted
-    # NOTE: HoldingInstitutions are stored in the production database (so don't get any crazy ideas when refactoring this code)
-    def set_sources(holding_institution_ids, collection_ids, item_ids)
-      registry = init_registry_entry
-      registry.holding_institution_ids = Array(holding_institution_ids).uniq
-      registry.collection_ids = Array(collection_ids).uniq
-      registry.item_ids = Array(item_ids).uniq
-
-      if holding_institution_ids.any? || collection_ids.any? || item_ids.any?
-        registry.save!
-        set_sourceable_cache_column(true)
-      elsif registry.persisted?
-        registry.destroy
-        set_sourceable_cache_column(false)
+      sources = Array(sources).flatten
+      sources.each do |source|
+        source_scope(source).delete_all
       end
+      update_sourceable_cache_column(false) if self.sourceable_registry_entries.empty?
     end
+    alias_method :remove_source, :remove_sources
     
     private
 
-    def init_registry_entry
-      raise "Cannot set sources of a #{self.class.name}. They are sourced through #{acts_as_sourceable_options[:through]}" if acts_as_sourceable_options[:through]
-
-      ActsAsSourceable::Registry.where(:sourceable_type => self.class.name, :sourceable_id => self.id).first_or_initialize
+    def source_scope(source)
+      ActsAsSourceable::RegistryEntry.where(:sourceable_type => self.class.name, :sourceable_id => self.id, :source_type => source.class, :source_id => source.id)
     end
-    
-    def set_sourceable_cache_column(value)
-      update_column(acts_as_sourceable_options[:cache_column], value) if acts_as_sourceable_options[:cache_column] # Update via sql because we don't need callbacks and validations called
+ 
+    def update_sourceable_cache_column(value = nil)
+      return unless acts_as_sourceable_options[:cache_column] # Update via sql because we don't need callbacks and validations called
+
+      if value
+        update_column(acts_as_sourceable_options[:cache_column], value)
+      else
+        update_column(acts_as_sourceable_options[:cache_column], sourceable_registry_entries.present?)
+      end
     end
   end
 
   module HelperMethods
-    # Given an array of HoldingInstitutions, Collections, and Items, returns arrays containing only the records of each class.
-    # Order of return arrays is [HoldingInstitutions, Collections, Items]
-    def self.group_by_class(*sources)
-      groups = Array(sources).flatten.group_by(&:class)
-      return [groups[HoldingInstitution] || [], groups[Collection] || [], groups[Item] || []]
-    end
-
-    def self.group_ids_by_class(*sources)
-      group_by_class(*sources).collect!{|group| group.collect(&:id)}
-    end
-
-    # Removes sourceable institutions that no longer belong to a record or holding institution
+    # Removes registry entries that no longer belong to a sourceable, item, collection, or holding institution
     def self.garbage_collect
-      ActsAsSourceable::Registry.pluck(:sourceable_type).uniq.each do |sourceable_type|
+      # Remove all registry entries where the sourceable is gone
+      ActsAsSourceable::RegistryEntry.pluck(:sourceable_type).uniq.each do |sourceable_type|
         sourceable_table_name = sourceable_type.constantize.table_name
-        sourceable_id_sql = ActsAsSourceable::Registry
-          .select("#{ActsAsSourceable::Registry.table_name}.id")
+        sourceable_id_sql = ActsAsSourceable::RegistryEntry
+          .select("#{ActsAsSourceable::RegistryEntry.table_name}.id")
           .where(:sourceable_type => sourceable_type)
-          .joins("LEFT OUTER JOIN #{sourceable_table_name} ON #{sourceable_table_name}.id = #{ActsAsSourceable::Registry.table_name}.sourceable_id")
+          .joins("LEFT OUTER JOIN #{sourceable_table_name} ON #{sourceable_table_name}.id = #{ActsAsSourceable::RegistryEntry.table_name}.sourceable_id")
           .where("#{sourceable_table_name}.id IS NULL").to_sql
 
-        ActsAsSourceable::Registry.delete_all("id IN (#{sourceable_id_sql})")
+        ActsAsSourceable::RegistryEntry.delete_all("id IN (#{sourceable_id_sql})")
       end
 
-
-      # Repair all Registry entries that reference missing items, collections, or holding institutions
-      holding_institution_ids = HoldingInstitution.pluck(:id)
-      collection_ids = Collection.pluck(:id)
-
-      [:holding_institution, :collection, :item].each do |type|
-        registries = ActsAsSourceable::Registry
-        registries = registries.joins("LEFT OUTER JOIN #{type}s ON #{type}s.id = ANY(#{type}_ids)")
-        registries = registries.group("#{ActsAsSourceable::Registry.table_name}.id")        
-        # Having at least one listed source_id and no matching sources, or fewer matches than the total listed sources
-        registries = registries.having("(array_length(#{type}_ids, 1) > 0 AND EVERY(#{type}s.id IS NULL)) OR count(*) < array_length(#{type}_ids, 1)")
-
-        # Fix the registry entries that are wrong
-        registries.includes(:sourceable).each do |registry|
-          item_ids = Item.where(:id => registry.item_ids).pluck(:id)
-          # ActiveRecord::Base.logger.debug "Registry #{registry.id}: holding_institution_ids: #{registry.holding_institution_ids.inspect} => #{registry.holding_institution_ids & holding_institution_ids}, collection_ids: #{registry.collection_ids.inspect} => #{registry.collection_ids & collection_ids}, item_ids: #{registry.item_ids.inspect} => #{registry.item_ids & item_ids} "
-          registry.sourceable.set_sources(registry.holding_institution_ids & holding_institution_ids, registry.collection_ids & collection_ids, registry.item_ids & item_ids)
-        end
+      # Remove all registry entries where the source is gone
+      ActsAsSourceable::RegistryEntry.pluck(:source_type).uniq.each do |source_type|
+        source_class = source_type.constantize
+        source_table_name = source_class.table_name
+        source_id_sql = ActsAsSourceable::RegistryEntry
+          .select("#{ActsAsSourceable::RegistryEntry.table_name}.id")
+          .where(:source_type => source_type)
+          .joins("LEFT OUTER JOIN #{source_table_name} ON #{source_table_name}.id = #{ActsAsSourceable::RegistryEntry.table_name}.source_id")
+          .where("#{source_table_name}.id IS NULL").to_sql
+
+        sourceables = ActsAsSourceable::RegistryEntry.where("id IN (#{source_id_sql})").collect(&:sourceable)
+        ActsAsSourceable::RegistryEntry.where("id IN (#{source_id_sql})").delete_all
+        sourceables.each{|sourceable| sourceable.send(:update_sourceable_cache_column) }
       end
     end
   end

data/lib/acts_as_sourceable/registry_entry.rb

@@ -0,0 +1,9 @@
+module ActsAsSourceable
+  class RegistryEntry < ActiveRecord::Base
+    self.table_name = 'acts_as_sourceable_registry'
+
+    belongs_to :sourceable, :polymorphic => true
+    belongs_to :source, :polymorphic => true
+    validates_presence_of :sourceable_type, :sourceable_id, :source_type, :source_id
+  end
+end

data/lib/acts_as_sourceable.rb

@@ -1,4 +1,4 @@
 require 'acts_as_sourceable/acts_as_sourceable'
-require 'acts_as_sourceable/registry'
+require 'acts_as_sourceable/registry_entry'
 
 ActiveRecord::Base.extend ActsAsSourceable::ActMethod

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_sourceable
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,18 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-01-26 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: postgres_ext
-  requirement: &70193900896400 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *70193900896400
+dependencies: []
 description: Allows the RRN to perform garbage collection on categories that are no
   longer referenced.
 email: technical@rrnpilot.org
@@ -31,9 +20,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/acts_as_sourceable/acts_as_sourceable.rb
-- lib/acts_as_sourceable/registry.rb
+- lib/acts_as_sourceable/registry_entry.rb
 - lib/acts_as_sourceable.rb
-- README.rdoc
+- README.md
 homepage: http://github.com/rrn/acts_as_sourceable
 licenses: []
 post_install_message: 
@@ -54,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: perform garbage collection on categories that are no longer referenced

data/README.rdoc

@@ -1,3 +0,0 @@
-== ActsAsSourceable
-
-Allows the RRN to perform garbage project on categories that are no longer referenced.

data/lib/acts_as_sourceable/registry.rb

@@ -1,12 +0,0 @@
-module ActsAsSourceable
-  class Registry < ActiveRecord::Base
-    self.table_name = 'acts_as_sourceable_registry'
-
-    belongs_to :sourceable, :polymorphic => true
-    validates_presence_of :sourceable_type, :sourceable_id
-
-    def sources
-       HoldingInstitution.find(self.holding_institution_ids) + Collection.find(self.collection_ids) + Item.find(self.item_ids)
-    end
-  end
-end