lifesaver 0.0.1 → 0.1.0

data/spec/unit/notification/traversal_queue_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Lifesaver::Notification::TraversalQueue do
+  let(:traversal_queue) { Lifesaver::Notification::TraversalQueue.new }
+  let(:model) { Model.new(1) }
+
+  describe '#push' do
+    it 'adds an univisited model' do
+      traversal_queue.push(model)
+
+      expect(traversal_queue.size).to eql(1)
+    end
+
+    it 'ignores a visited model' do
+      traversal_queue.push(model)
+      traversal_queue.push(model)
+
+      expect(traversal_queue.size).to eql(1)
+    end
+  end
+
+  describe '#<<' do
+    it 'adds an univisited model' do
+      traversal_queue << model
+
+      expect(traversal_queue.size).to eql(1)
+    end
+
+    it 'ignores a visited model' do
+      traversal_queue << model
+      traversal_queue << model
+
+      expect(traversal_queue.size).to eql(1)
+    end
+  end
+
+  describe '#pop' do
+    context 'when not empty' do
+      it 'returns the first model in the queue' do
+        another_model = Model.new(3)
+        traversal_queue << model
+        traversal_queue << another_model
+
+        expect(traversal_queue.pop).to eql(model)
+      end
+    end
+
+    context 'when empty' do
+      it 'returns nil' do
+        expect(traversal_queue.pop).to be_nil
+      end
+    end
+  end
+
+  describe '#empty?' do
+    it 'is true when empty' do
+      expect(traversal_queue.empty?).to be_true
+    end
+
+    it 'is not true when not empty' do
+      traversal_queue << model
+
+      expect(traversal_queue.empty?).to be_false
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lifesaver
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,6 +165,7 @@ extra_rdoc_files: []
 files:
 - .coveralls.yml
 - .gitignore
+- .rspec
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -172,21 +173,36 @@ files:
 - README.md
 - Rakefile
 - lib/lifesaver.rb
-- lib/lifesaver/index_graph.rb
+- lib/lifesaver/config.rb
 - lib/lifesaver/index_worker.rb
-- lib/lifesaver/marshal.rb
-- lib/lifesaver/model_additions.rb
+- lib/lifesaver/indexing/enqueuer.rb
+- lib/lifesaver/indexing/indexer.rb
+- lib/lifesaver/indexing/model_additions.rb
+- lib/lifesaver/notification/eager_loader.rb
+- lib/lifesaver/notification/enqueuer.rb
+- lib/lifesaver/notification/indexing_graph.rb
+- lib/lifesaver/notification/model_additions.rb
+- lib/lifesaver/notification/notifiable_associations.rb
+- lib/lifesaver/notification/traversal_queue.rb
 - lib/lifesaver/railtie.rb
+- lib/lifesaver/serialized_model.rb
 - lib/lifesaver/version.rb
 - lib/lifesaver/visitor_worker.rb
 - lifesaver.gemspec
-- spec/lifesaver/index_graph_spec.rb
-- spec/lifesaver/marshal_spec.rb
-- spec/lifesaver/model_additions_spec.rb
-- spec/lifesaver_spec.rb
+- spec/integration/lifesaver_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
 - spec/support/test_models.rb
+- spec/support/tire_helper.rb
+- spec/unit/config_spec.rb
+- spec/unit/indexing/indexer_spec.rb
+- spec/unit/indexing/model_addtions_spec.rb
+- spec/unit/notification/eager_loader_spec.rb
+- spec/unit/notification/enqueuer_spec.rb
+- spec/unit/notification/indexing_graph_spec.rb
+- spec/unit/notification/model_additions_spec.rb
+- spec/unit/notification/notifiable_associations_spec.rb
+- spec/unit/notification/traversal_queue_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -206,18 +222,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3695998717918674218
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Indexes your ActiveRecord models in elasticsearch asynchronously by making
   use of tire and resque
 test_files:
-- spec/lifesaver/index_graph_spec.rb
-- spec/lifesaver/marshal_spec.rb
-- spec/lifesaver/model_additions_spec.rb
-- spec/lifesaver_spec.rb
+- spec/integration/lifesaver_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
 - spec/support/test_models.rb
+- spec/support/tire_helper.rb
+- spec/unit/config_spec.rb
+- spec/unit/indexing/indexer_spec.rb
+- spec/unit/indexing/model_addtions_spec.rb
+- spec/unit/notification/eager_loader_spec.rb
+- spec/unit/notification/enqueuer_spec.rb
+- spec/unit/notification/indexing_graph_spec.rb
+- spec/unit/notification/model_additions_spec.rb
+- spec/unit/notification/notifiable_associations_spec.rb
+- spec/unit/notification/traversal_queue_spec.rb

data/lib/lifesaver/index_graph.rb

@@ -1,53 +0,0 @@
-module Lifesaver
-  class IndexGraph
-    def self.generate(marshalled_models)
-      models_to_index = []
-      visited_models = {}
-      graph = []
-      marshalled_models.each do |m|
-        mdl, opts = Lifesaver::Marshal.load(m)
-        if mdl
-          if opts[:status] == :notified
-            graph << mdl
-          elsif opts[:status] == :changed
-            visited_models[self.visited_model_key(mdl)] = true
-            graph |= self.notified_models(mdl, true)
-          end
-        end
-      end
-      graph.each {|m| visited_models[self.visited_model_key(m)] = true }
-      while !graph.empty?
-        mdl = graph.shift
-        models_to_index << mdl if mdl.has_index?
-        self.notified_models(mdl).each do |m|
-          unless visited_models[self.visited_model_key(m)]
-            visited_models[self.visited_model_key(m)] = true
-            graph << m
-          end
-        end
-      end
-      models_to_index
-     end
-
-     def self.visited_model_key(mdl)
-       if mdl.is_a?(Hash)
-         klass = mdl[:class].to_s.classify
-         "#{klass}_#{mdl[:id]}"
-       elsif mdl.try(:id)
-         "#{mdl.class.name}_#{mdl.id}"
-       end
-     end
-
-     def self.notified_models(mdl, on_change = false)
-       if Lifesaver::Marshal.is_serialized?(mdl)
-         mdl, opts = Lifesaver::Marshal.load(mdl)
-       end
-       models = []
-       key = on_change ? :on_change : :on_notify
-       mdl.class.notifiable_associations[key].each do |assoc|
-         models |= mdl.association_models(assoc)
-       end
-       models
-     end
-  end
-end

data/lib/lifesaver/marshal.rb

@@ -1,43 +0,0 @@
-module Lifesaver
-  class Marshal
-    def self.dump(obj, opts={})
-      raise unless opts.is_a?(Hash)
-      opts[:class] = obj.class.name.underscore.to_sym
-      opts[:id] = obj.id
-      opts
-    end
-
-    def self.load(obj)
-      raise unless self.is_serialized?(obj)
-      obj = self.sanitize(obj)
-      klass = obj[:class].to_s.classify.constantize
-      if klass.exists?(obj[:id])
-        mdl = klass.find(obj[:id])
-        obj.delete(:id)
-        obj.delete(:class)
-        return mdl, obj
-      else
-        nil
-      end
-    end
-
-    def self.sanitize(obj)
-      raise unless obj.is_a?(Hash)
-      obj = obj.symbolize_keys
-      obj[:id] = obj[:id].to_i if obj[:id]
-      obj[:class] = obj[:class].to_sym if obj[:class]
-      obj[:status] = obj[:status].to_sym if obj[:status]
-      obj
-    end
-
-    def self.is_serialized?(obj)
-      if obj.is_a?(Hash)
-        obj = self.sanitize(obj)
-        if obj.key?(:class) && obj.key?(:id)
-          return true
-        end
-      end
-      false
-    end
-  end
-end

data/lib/lifesaver/model_additions.rb

@@ -1,133 +0,0 @@
-module Lifesaver
-  module ModelAdditions
-    module ClassMethods
-
-      def notifies_for_indexing(*args)
-        self.notifiable_associations = { on_change: [], on_notify: [] }
-        opts = args.pop if args.last.is_a?(Hash)
-        args.each do |a|
-          self.notifiable_associations[:on_change] << a
-          self.notifiable_associations[:on_notify] << a
-        end
-        %w(on_change on_notify).each do |k|
-          opt = opts[("only_" + k).to_sym] if opts
-          key = k.to_sym
-          if opt
-            if opt.is_a?(Array)
-              self.notifiable_associations[key] |= opt
-            else
-              self.notifiable_associations[key] << opt
-            end
-          end
-        end
-        notification_callbacks
-      end
-
-      def enqueues_indexing(options = {})
-        indexing_callbacks
-      end
-
-      private
-
-      def notification_callbacks(options={})
-        after_save do
-          send :update_associations, options.merge(operation: :update)
-        end
-        before_destroy do
-          send :update_associations, options.merge(operation: :destroy)
-        end
-      end
-
-      def indexing_callbacks(options={})
-        after_save do
-          send :enqueue_indexing, options.merge(operation: :update)
-        end
-        after_destroy do
-          send :enqueue_indexing, options.merge(operation: :destroy)
-        end
-      end
-    end
-
-    def self.included(base)
-      base.class_attribute :notifiable_associations
-      base.notifiable_associations = { on_change: [], on_notify: [] }
-      base.extend(ClassMethods)
-    end
-
-    def association_models(assoc)
-       models = []
-       association = send(assoc.to_sym)
-       unless association.nil?
-         if association.respond_to?(:each)
-           association.each do |m|
-             models << m
-           end
-         else
-           models << association
-         end
-       end
-       models
-     end
-
-     def has_index?
-       self.respond_to?(:tire)
-     end
-
-     def suppress_indexing
-       @indexing_suppressed = true
-     end
-
-     def unsuppress_indexing
-       @indexing_suppressed = false
-     end
-
-    private
-
-    def enqueue_indexing(opts)
-      if has_index? && !suppress_indexing?
-        ::Resque.enqueue(
-          Lifesaver::IndexWorker,
-          self.class.name.underscore.to_sym,
-          self.id,
-          opts[:operation]
-        )
-      end
-    end
-
-    def dependent_association_map
-      dependent = {}
-      self.class.reflect_on_all_associations.each do |assoc|
-        dependent[assoc.name.to_sym] = true if assoc.options[:dependent].present?
-      end
-      dependent
-    end
-
-    def update_associations(opts)
-      models = []
-      if opts[:operation] == :destroy
-        dependent = dependent_association_map
-        assoc_models = []
-        self.class.notifiable_associations[:on_change].each do |assoc|
-          assoc_models |= association_models(assoc) unless dependent[assoc]
-        end
-        assoc_models.each do |m|
-          models << Lifesaver::Marshal.dump(m, {status: :notified})
-        end
-      elsif opts[:operation] == :update
-        models << Lifesaver::Marshal.dump(self, {status: :changed})
-      end
-
-      ::Resque.enqueue(Lifesaver::VisitorWorker, models) unless models.empty?
-    end
-
-    def validate_options(options)
-      # on: should only have active model callback verbs (create, update, destroy?)
-      # after: (next versions after you use resque scheduler) time to schedule
-      # only: specifies fields that trigger changes
-    end
-
-    def suppress_indexing?
-      Lifesaver.indexing_suppressed? || @indexing_suppressed || false
-    end
-  end
-end

data/spec/lifesaver/index_graph_spec.rb

@@ -1,64 +0,0 @@
-require 'spec_helper'
-
-describe Lifesaver::IndexGraph do
-  Lifesaver.suppress_indexing
-
-  describe ".visited_model_key" do
-    it "should return a key when passed an ActiveRecord model" do
-      post = Post.create(title: "Some post")
-      expect(Lifesaver::IndexGraph.visited_model_key(post)).to eql("Post_1")
-    end
-
-    it "should return a key when passed a Hash" do
-      post = {class: "post", id: "1", status: "notified"}
-      expect(Lifesaver::IndexGraph.visited_model_key(post)).to eql("Post_1")
-    end
-  end
-
-  describe ".notified_models" do
-    after(:all) do
-      Post.destroy_all
-      Author.destroy_all
-      Authorship.destroy_all
-    end
-    context "when passed model has changed" do
-      before(:each) do
-        @post = Post.create(title: "Some post")
-        @author = Author.create(name: "Some guy")
-        Authorship.create(post: @post, author: @author)
-      end
-      
-      it "should return notified models when passed an ActiveRecord model" do
-        models = Lifesaver::IndexGraph.notified_models(@post, true)
-        expect(models.size).to eql(1)
-      end
-
-      it "should return notified models when passed a Hash" do
-        post = {class: "post", id: "1", status: "changed"}
-        models = Lifesaver::IndexGraph.notified_models(post, true)
-        expect(models.size).to eql(1)
-      end
-    end
-
-    context "when passed model has not changed" do
-      before(:each) do
-        @post = Post.create(title: "Some post")
-        @author = Author.create(name: "Some guy")
-        Authorship.create(post: @post, author: @author)
-      end
-
-      it "should return notified models when passed an ActiveRecord model" do
-        models = Lifesaver::IndexGraph.notified_models(@author)
-        expect(models.size).to eql(1)
-      end
-      
-      it "should return notified models when passed a Hash" do
-        author = {class: "author", id: "1", status: "notified"}
-        models = Lifesaver::IndexGraph.notified_models(author)
-        expect(models.size).to eql(1)
-      end
-    end
-  end
-
-  Lifesaver.unsuppress_indexing
-end