es-reindex 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bfec9b90b4f6f60bca9fbc2e31b512e91859ee0
-  data.tar.gz: 34d5f1814a05ad2cb3eeee1427bb8fb1126006a0
+  metadata.gz: 142c4bceb879849117f58dea9019a4ad38bebc58
+  data.tar.gz: 4676e75a520fe3eb18660000b72b1d4b639ffca2
 SHA512:
-  metadata.gz: fa461c5f68ded8c5e1fb03436cc414df23d7c7dd21e8896c29675c21f6d1a5b5114db2a19de2027d0bbd6ccb773441fb9b59781bf1b769b9d60a597e17828ead
-  data.tar.gz: 0a7288a5c3a040c061f99bdb32f3153789cf76d13827535f3a2a5f866469d65527e4f85d2df1f184c40506fe01ad8afd47bca3f60c3f05cf23332e4963f84b38
+  metadata.gz: 896bbe493132b19ed83182fbd83464ec3dae02779ada820b08cac30b7801433ab0213cd6e7f71a56d1a5357d3f2df80bfff90f4c83055ef5883271535f938745
+  data.tar.gz: d220120b5a19c873eb0dfc7630a469ce37bc705e2510a8825588fae161a442e33c2ed3462bd3ec54a594930c4df87ea6fff827e933b6e59971b0b81cd5978f68

data/README.markdown

@@ -77,8 +77,21 @@ ESReindex.copy! 'http://my_server/index', 'http://my_server/index_copy',
   after_copy:    ->    { finish_thing }       # Runs after everything is copied over
 ```
 
+#### Callbacks (guards)
+
+You can also use the `:if` or `:unless` callbacks to prevent the copy/reindexing from occuring if conditions are (un)met.  The source client and destination client are passed in:
+
+```ruby
+ESReindex.copy! 'http://my_server/index', 'http://my_server/index_copy',
+  if:     ->(sclient,dclient) { Time.now.hour > 20 },                 # Only copy the indexes if it's after 8pm
+  unless: ->(sclient,dclient) { Time.now.strftime("%A") == "Friday" } # Never copy on Fridays
+```
+
+For a more practical example, see the [reindex integration specs](spec/integration/reindex_spec.rb).
+
 ## Changelog
 
++ __0.3.0__: Add `:if` and `:unless` callbacks
 + __0.2.1__: [BUGFIX] Improve callback presence check
 + __0.2.0__: Lots of bugfixes, use elasticsearch client gem, add .reindex! method and callbacks
 + __0.1.0__: First gem release

data/lib/es-reindex.rb

@@ -12,14 +12,14 @@ class ESReindex
   def self.copy!(src, dst, options = {})
     self.new(src, dst, options).tap do |reindexer|
       reindexer.setup_index_urls
-      reindexer.copy!
+      reindexer.copy! if reindexer.okay_to_proceed?
     end
   end
 
   def self.reindex!(src, dst, options={})
     self.new(src, dst, options.merge(copy_mappings: false)).tap do |reindexer|
       reindexer.setup_index_urls
-      reindexer.copy!
+      reindexer.copy! if reindexer.okay_to_proceed?
     end
   end
 
@@ -36,6 +36,14 @@ class ESReindex
       copy_mappings: true # Copy old mappings/settings
     }.merge! options
 
+    %w{
+      if unless mappings settings before_create after_create before_each after_each after_copy
+    }.each do |callback|
+      if options[callback.to_sym].present? && !options[callback.to_sym].respond_to?(:call)
+        raise ArgumentError, "#{callback} must be a callable object"
+      end
+    end
+
     @done = 0
   end
 
@@ -55,6 +63,14 @@ class ESReindex
     @dclient = Elasticsearch::Client.new host: durl
   end
 
+  def okay_to_proceed?
+    okay = true
+    okay = options[:if].call(sclient, dclient) if options[:if].present?
+    okay = (okay && !(options[:unless].call sclient, dclient)) if options[:unless].present?
+    log 'Skipping action due to guard callbacks' unless okay
+    okay
+  end
+
   def copy!
     log "Copying '#{surl}/#{sidx}' to '#{durl}/#{didx}'#{remove? ? ' with rewriting destination mapping!' : update? ? ' with updating existing documents!' : '.'}"
     confirm if from_cli?
@@ -97,13 +113,13 @@ class ESReindex
         create_msg = ""
       end
 
-      options[:before_create].call if options[:before_create] && options[:before_create].respond_to?(:call)
+      options[:before_create].try(:call)
 
       log "Creating '#{durl}/#{didx}' index#{create_msg}..."
       dclient.indices.create index: didx, body: { settings: settings, mappings: mappings }
       log "Succesfully created '#{durl}/#{didx}''#{create_msg}."
 
-      options[:after_create].call if options[:after_create] && options[:after_create].respond_to?(:call)
+      options[:after_create].try(:call)
     end
 
     true
@@ -141,13 +157,13 @@ class ESReindex
     while scroll = sclient.scroll(scroll_id: scroll['_scroll_id'], scroll: '10m') and not scroll['hits']['hits'].empty? do
       bulk = []
       scroll['hits']['hits'].each do |doc|
-        options[:before_each].call doc if options[:before_each] && options[:before_each].respond_to?(:call)
+        options[:before_each].try(:call)
         ### === implement possible modifications to the document
         ### === end modifications to the document
         base = {'_index' => didx, '_id' => doc['_id'], '_type' => doc['_type'], data: doc['_source']}
         bulk << {action => base}
         @done = done + 1
-        options[:after_each].call doc if options[:after_each] && options[:after_each].respond_to?(:call)
+        options[:after_each].try(:call)
       end
       unless bulk.empty?
         dclient.bulk body: bulk
@@ -159,7 +175,7 @@ class ESReindex
 
     log "Copy progress: %u/%u done in %s.\n" % [done, total, tm_len]
 
-    options[:after_copy].call if options[:after_copy] && options[:after_copy].respond_to?(:call)
+    options[:after_copy].try(:call)
 
     true
   end

data/lib/es-reindex/version.rb

@@ -1,3 +1,3 @@
 class ESReindex
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/es-reindex_spec.rb

@@ -11,6 +11,16 @@ describe ESReindex do
     expect(reindexer.options).to eq remove: false, update: true, frame: 1000, from_cli: false, copy_mappings: true
   end
 
+  context "with invalid callback options" do
+    let(:options) { {if: :not_a_proc} }
+
+    it "fails" do
+      expect{
+        reindexer
+      }.to raise_error ArgumentError, "if must be a callable object"
+    end
+  end
+
   it "starts with 0 indexes done" do
     expect(reindexer.done).to eq 0
   end

data/spec/integration/reindex_spec.rb

@@ -8,7 +8,6 @@ describe "reindex!", type: :integration do
   let!(:new_klass)       { test_klass index_name: new_index_name, attributes: [:foo] }
 
   let(:test_post)        { original_klass.create id: 1, text: 'test_post' }
-  let(:test_post_2)      { new_klass.create      id: 2, text: 'other_post' }
 
   # Create the index (test_index) on the test_klass:
   before do
@@ -19,13 +18,55 @@ describe "reindex!", type: :integration do
 
   let(:reindexed_post) { new_klass.find test_post.id }
 
+  let(:reindex)    { ESReindex.reindex! "#{ES_HOST}/#{orig_index_name}", "#{ES_HOST}/#{new_index_name}", opts }
+  let(:mappings)   { ->{ new_klass.mappings } }
+  let(:settings)   { ->{ new_klass.settings } }
+  let(:other_opts) { {} }
+  let(:opts)       { {mappings: mappings, settings: settings}.merge other_opts }
+
   it "reindexes with the selected mappings" do
-    ESReindex.reindex! "#{ES_HOST}/#{orig_index_name}", "#{ES_HOST}/#{new_index_name}",
-      mappings: -> { new_klass.mappings },
-      settings: -> { new_klass.settings }
+    reindex
 
     expect(reindexed_post.id).to   eq test_post.id
     expect(reindexed_post.text).to eq test_post.text
     expect(reindexed_post).to respond_to :foo
   end
+
+  context "with a :unless guard" do
+    let(:other_opts) do
+      {
+        unless: ->(sclient,dclient) {
+          existing_properties = sclient.indices.get_mapping(index: orig_index_name)[orig_index_name]['mappings']['test_klass']['properties']
+          existing_mappings = existing_properties.inject({}) do |result, (k,v)|
+            result[k.to_sym] = {type: v['type']}
+            result
+          end
+          new_mappings = klass_to_use_as_source.mappings.to_hash[:test_klass][:properties]
+          existing_mappings.sort == new_mappings.sort
+        }
+      }
+    end
+
+    context "when the unless call returns true" do
+      let(:klass_to_use_as_source) { original_klass }
+
+      it "does not reindex" do
+        reindex
+        original_klass.refresh_index!
+        expect(test_post.id).to be_present
+        expect { test_post.foo}.to raise_error NoMethodError
+      end
+    end
+
+    context "when the unless call returns false" do
+      let(:klass_to_use_as_source) { new_klass }
+
+      it "reindexes" do
+        reindex
+        expect(reindexed_post.id).to   eq test_post.id
+        expect(reindexed_post.text).to eq test_post.text
+        expect(reindexed_post).to respond_to :foo
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: es-reindex
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Aiken
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch