has_reindexable_associations 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb3caa27d7fd9f6de7c61270f35e47b75024076e
+  data.tar.gz: 7ba1991147e8fb13fb4b943662c55fb67b3a10dd
+SHA512:
+  metadata.gz: 72784bfc8bbd82402e196601ae45a40fba8834b03e19f2b6279d13ac8d9607748cf091dfce8ca690d9414b466408bfff90a7486d63114b168133575fcd7af3b0
+  data.tar.gz: b02de0a9d55aaab9b65f34ea35956b1c834d00638df428676c4a29572d746646d18c95cfd3f0dc63a42d5897f98406018b64e66da73a7ba3bee5ece25e27391f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+/db/*.sqlite3
+/*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2
+services:
+  - elasticsearch

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mkalita@artegence.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_reindexable_associations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Efigence
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# HasReindexableAssociations [![Build Status](https://travis-ci.org/efigence/has_reindexable_associations.svg?branch=master)](https://travis-ci.org/efigence/has_reindexable_associations)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/has_reindexable_associations`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_reindexable_associations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_reindexable_associations
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/has_reindexable_associations. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## TODO
+
+  write README.md
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "has_reindexable_associations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/has_reindexable_associations.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_reindexable_associations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_reindexable_associations"
+  spec.version       = HasReindexableAssociations::VERSION
+  spec.authors       = ["Marcin Kalita"]
+  spec.email         = ["mkalita@efigence.com"]
+
+  spec.summary       = %q{Automatic Elasticsearch Reindexing of Active Record Associations}
+  spec.description   = %q{Keep specified associations in sync with ease using async reindexing (searchkick gem).}
+  spec.homepage      = "https://github.com/efigence/has_reindexable_associations"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  # spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = [".gitignore",
+                        ".travis.yml",
+                        "CODE_OF_CONDUCT.md",
+                        "Gemfile",
+                        "LICENSE.txt",
+                        "README.md",
+                        "Rakefile",
+                        "bin/console",
+                        "bin/setup",
+                        "has_reindexable_associations.gemspec",
+                        "lib/has_reindexable_associations.rb",
+                        "lib/has_reindexable_associations/version.rb"]
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 4.1"
+  spec.add_dependency "searchkick", ">= 0.9.1"
+  spec.add_development_dependency "sqlite3", ">= 1.3.10"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/has_reindexable_associations/version.rb

@@ -0,0 +1,3 @@
+module HasReindexableAssociations
+  VERSION = "0.1.2"
+end

data/lib/has_reindexable_associations.rb

@@ -0,0 +1,113 @@
+require "has_reindexable_associations/version"
+require 'rails/all'
+require 'searchkick'
+
+# To avoid full model reindex, one can't just call reindex on a scope.
+# One must call reindex_async on each associated record.
+# Usage:
+# MyClass < ActiveRecord::Base
+# include HasReindexableAssociations
+# belongs_to :some_association
+# has_many :some_associations
+# has_reindexable_associations :some_association, :some_associations
+module HasReindexableAssociations
+  extend ActiveSupport::Concern
+
+  class_methods do
+    cattr_writer :reindexable_associations
+
+    # Set this to `true` before any seeds or imports to reindex associations later on your own like this:
+    # MyClass.reindexable_associations_skip = true
+    # MyClass.import(...)
+    # MyClass.reindex
+    # MyClass.reindexable_associations_skip = false
+    # MyClass.reindexable_associations.each { |association| MyClass.send(association).model.reindex }
+    cattr_accessor :reindexable_associations_skip
+
+    def has_reindexable_associations(*args)
+      # @@ is shared between classes via concern, not what we want
+      # @@reindexable_associations = args
+      self.class_variable_set :@@reindexable_associations, args
+    end
+
+    def reindexable_associations
+      # @@reindexable_associations || []
+      self.class_variable_get :@@reindexable_associations
+    rescue NameError
+      []
+    end
+  end
+
+  included do
+    after_commit :reindex_associations
+
+    private
+
+    def reindex_associations
+      self.class.reindexable_associations.each do |reindexable_association|
+        reindex_associations_process(reindexable_association)
+      end
+    end
+
+    def reindex_associations_process(reindexable_association)
+      record_or_records = reindex_associations_scope(reindexable_association)
+      if record_or_records.respond_to?(:to_a)
+        reindex_associations_process_records(record_or_records, reindexable_association)
+      else
+        reindex_associations_process_record(record_or_records, reindexable_association)
+      end
+    end
+
+    def reindex_associations_scope(reindexable_association)
+      begin
+        record_or_records = self.send(reindexable_association)
+      rescue NoMethodError
+        fail NoMethodError.new("foreign key '#{reindexable_association}' is not defined, verify has_reindexable_associations options")
+      end
+    end
+
+    def reindex_associations_process_records(records, reindexable_association)
+      unless self.class.reindexable_associations_skip
+        records.to_a.each do |record|
+          reindex_associations_process_record(record, reindexable_association)
+        end
+      end
+    end
+
+    def reindex_associations_process_record(record, reindexable_association)
+      reindex_association(record)
+      reindex_associations_process_old_record(reindexable_association)
+    end
+
+    def reindex_association(record)
+      record.reindex_async
+    end
+
+    def reindex_associations_find_old_polymorphic_association(reindexable_association)
+      key, type = reindex_associations_describe_polymorphic_association(reindexable_association)
+      old_klass = reindex_associations_describe_old_polymorphic_association(key, type)
+      return unless old_klass && previous_changes[key] && previous_changes[key].first
+      old_record = old_klass.where(id: previous_changes[key].first).first
+    end
+
+    def reindex_associations_process_old_record(reindexable_association)
+      old_record = reindex_associations_find_old_polymorphic_association(reindexable_association)
+      reindex_association(old_record) if old_record
+    end
+
+    def reindex_associations_describe_polymorphic_association(reindexable_association)
+      key = self.class.reflect_on_association(reindexable_association).try(:foreign_key)
+      type = self.class.reflect_on_association(reindexable_association).try(:foreign_type)
+      [key, type]
+    end
+
+    def reindex_associations_describe_old_polymorphic_association(key, type)
+      if (previous_changes[key] && previous_changes[key].first) || (previous_changes[type] && previous_changes[type].first)
+        old_klass = previous_changes[type].first rescue NameError
+        old_klass = self.send(type).constantize if old_klass == NameError
+      end
+    rescue NameError
+    end
+  end
+end
+

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: has_reindexable_associations
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Marcin Kalita
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: searchkick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Keep specified associations in sync with ease using async reindexing
+  (searchkick gem).
+email:
+- mkalita@efigence.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- has_reindexable_associations.gemspec
+- lib/has_reindexable_associations.rb
+- lib/has_reindexable_associations/version.rb
+homepage: https://github.com/efigence/has_reindexable_associations
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Automatic Elasticsearch Reindexing of Active Record Associations
+test_files: []